Skip to content

Add Docs for filtering in Search Mode#423

Open
CShorten wants to merge 3 commits into
mainfrom
add-retrieval-strategy
Open

Add Docs for filtering in Search Mode#423
CShorten wants to merge 3 commits into
mainfrom
add-retrieval-strategy

Conversation

@CShorten
Copy link
Copy Markdown
Member

@CShorten CShorten commented May 22, 2026

The CI failure is due to a broken link unrelated to this PR

Type of change:

  • Feature or enhancements (non-breaking change to add functionality)

How has this been tested?

  • Local build - the site works as expected when running yarn start

Copy link
Copy Markdown

@orca-security-eu orca-security-eu Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@CShorten CShorten self-assigned this May 26, 2026
@CShorten CShorten changed the title Add Docs for retrieval_strategy in Search Mode Add Docs for filtering in Search Mode May 26, 2026
@dannyjameswilliams
Copy link
Copy Markdown

Could you potentially make the PR to this branch: #424 for the new docs or I suppose hold off and edit once it goes to main (which would require the same changes)?

Tagging @g-despot as I don't know the correct procedure in this case!

Comment on lines +289 to +290
- **`"recall"`** (default): Generates multiple Weaviate queries spanning different filters and interpretations of the user query.
- **`"precision"`**: Generates a single Weaviate query targeting the most likely interpretation of the user query.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd maybe add a little more detail to these, to help users understand when they should use each mode. Something like

 **`"recall"`** (default): Generates multiple Weaviate queries spanning different filters and interpretations of the user query.
You should use these when you prefer to get results, even if they don't match every criteria in your query.

- **`"precision"`**: Generates a single Weaviate query targeting the most likely interpretation of the user query.
You should use this when you want the results to follow your query intent closely, even if that means potentially receiving no results.

maybe?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants